withdrawal
Withdrawal
Overview
To initiate the withdrawal process, vendors need to call into the TCash API.
The staging environement for the TCash API is located at: https://staging.api.tcash.me
The process goes as follows:
Authentication
When calling the TCash API, authentication is done by passing your API key in the secret header of the request.
danger
Unless you request us to change the defaults, do not use the "Bearer" prefix, do not use the Authorization header. the Header format is: secret: <your-api-key>
Create a Withdrawal Request
Endpoint
Endpoint: https://staging.api.tcash.me/agent/money-transfer/voucher
Method: POSTRequest
| amount | integer <int32> |
{- "amount": 0
}danger
You need to send the amount as an integer, in cents. For example, if you want to send 250 EUR, you need to send 25000.
Response
| message | string or null |
Array of objects or null (ErrorDto) | |
(VoucherDto (object or null)) | |
| voucherUrl | string or null |
{- "message": "string",
- "errors": [
- {
- "code": "OK",
- "description": "string"
}
], - "moneyTransfer": {
- "moneyTransferId": "string",
- "moneyTransferCode": "string",
- "typeCode": "string",
- "from": {
- "walletId": 0,
- "company": "string",
- "identifier": "string",
- "agentTypeCode": "string"
}, - "to": {
- "walletId": 0,
- "company": "string",
- "identifier": "string",
- "agentTypeCode": "string"
}, - "amount": 0,
- "currencyCode": "string",
- "statusCode": "string",
- "date": "2019-08-24T14:15:22Z",
- "cashier": {
- "cashierId": "string",
- "fullName": "string"
}, - "venue": {
- "venueId": 0,
- "name": "string",
- "address": "string",
- "city": "string",
- "googleFullAddress": "string",
- "latitude": 0,
- "longitude": 0,
- "workingHours": [
- {
- "date": "string",
- "day": "string",
- "openAt": "string",
- "closeAt": "string"
}
]
}, - "voucherCode": "string"
}, - "voucherUrl": "string"
}